<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
		<title>farbot: FreeBSD Automated Release 'Bot</title>
		<meta http-equiv="content-type" content="text/html;
		charset=iso-8859-1"/>
		<link rel="stylesheet" type="text/css" href="default.css"/>
	</head>
	<body>
		<h1>farbot: FreeBSD Automated Release 'Bot</h1>

		<ul id="nav">
			<li><a href="#intro">Introduction</a></li>
			<li><a href="#get">Download</a></li>
			<li><a href="#require">Requirements</a></li>
			<li><a href="#support">Support</a></li>
			<li><a href="#cav">Caveats</a></li>
		</ul>

		<h2><a id="intro">Introduction</a></h2>
		<p>
                farbot automates building of netinstall/PXE boot FreeBSD releases. It features 
                a simple configuration file based on the concept of "installations".
		</p>

		<p>
                farbot currently handles the following:
		</p>

		<ul>
			<li>Building freebsd releases, including grabbing any source needed.</li>
			<li>Building packages for each release, derived from per installation package sets.</li>
			<li>Laying out an NFS/TFTP exportable file system structure for all built releases,
                            customized for each installation type.</li>
			<li>Generation of a customized bootloader with options to install each 
                            installation type </li>
		</ul>

		<h2><a id="get">Download</a></h2>
		<p>
			The source for farbot 1.0alpha1 can be downloaded
			<a href="farbot-1.0-alpha1.tar.gz">here</a>, and verified against this <a
				href="farbot-1.0-alpha1.tar.gz.sig">PGP signature.</a>
		</p>
		<p>
			The signing public key (key ID 4FF5E663) can be downloaded from
			<a href="http://www.opendarwin.org/~landonf/landonf-gpg.pubkey">OpenDarwin</a>
			and the
			<a href="http://pgp.mit.edu:11371/pks/lookup?op=get&#38;search=0x4FF5E663">MIT PGP Keyserver</a>.
				
		</p>
		<h2><a id="require">Requirements</a></h2>
		<ul>
			<li><a href="http://www.python.org">Python 2.4</a></li>
			<li><a href="http://twistedmatrix.com">Twisted Networking Framework</a></li>
			<li><a href="http://www.zope.org/Members/fdrake/zconfig/">Zconfig</a></li>
                        <li>To actually perform a release build farbot must be running on a FreeBSD host.</li>
		</ul>
		<p>
			farbot uses the standard Python distutils.
			To install, run setup.py:
		</p>
		<pre>./setup.py install</pre>

		<p>
			farbot will be installed in the Python site-packages directory.
			The <em>farbot</em> command line tool will be installed in the Python-specified 
                        bin directory. An example configuration
			file, <em>farbot.conf</em>, is supplied with the source distribution.
		</p>

		<h2><a id="support">Support</a></h2>
		<p>
			A <a href="manual/">farbot Manual</a> is available.
		</p>
		
		<h2><a id="mailinglist">Mailing List</a></h2>
                <p>
			You may also join the <a href="https://dpw.threerings.net/mailman/listinfo/farbot">farbot Mailing List</a>.
                </p>

		<h2><a id="authors">Authors</a></h2>
		<ul>
			<li>
                        Landon Fuller
			</li>
                        <li>
                        Jonathan Le Plastrier
                        </li>
		</ul>
	</body>
</html>	
